<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: RawBytesChannel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RawBytesChannel Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Side channel for managing raw bytes of data.  
 <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#details">More...</a></p>

<p>Inherits <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2805002955aa8f7c18fb6d689d94c7a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a2805002955aa8f7c18fb6d689d94c7a8">RawBytesChannel</a> (Guid channelId)</td></tr>
<tr class="memdesc:a2805002955aa8f7c18fb6d689d94c7a8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html" title="Side channel for managing raw bytes of data.">RawBytesChannel</a> provides a way to exchange raw byte arrays between <a class="el" href="namespaceUnity.html">Unity</a> and Python.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a2805002955aa8f7c18fb6d689d94c7a8">More...</a><br /></td></tr>
<tr class="separator:a2805002955aa8f7c18fb6d689d94c7a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab4c3259a1f7e7780b883d7469c805f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a7ab4c3259a1f7e7780b883d7469c805f">SendRawBytes</a> (byte[] data)</td></tr>
<tr class="memdesc:a7ab4c3259a1f7e7780b883d7469c805f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the byte array message to the Python side channel.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a7ab4c3259a1f7e7780b883d7469c805f">More...</a><br /></td></tr>
<tr class="separator:a7ab4c3259a1f7e7780b883d7469c805f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a641cf2de4e005eff057e46321e18ba5d"><td class="memItemLeft" align="right" valign="top">IList&lt; byte[]&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a641cf2de4e005eff057e46321e18ba5d">GetAndClearReceivedMessages</a> ()</td></tr>
<tr class="memdesc:a641cf2de4e005eff057e46321e18ba5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the messages that were sent by python since the last call to GetAndClearReceivedMessages.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a641cf2de4e005eff057e46321e18ba5d">More...</a><br /></td></tr>
<tr class="separator:a641cf2de4e005eff057e46321e18ba5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48b8107c737958a4feec339e6ea940bb"><td class="memItemLeft" align="right" valign="top">IList&lt; byte[]&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a48b8107c737958a4feec339e6ea940bb">GetReceivedMessages</a> ()</td></tr>
<tr class="memdesc:a48b8107c737958a4feec339e6ea940bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the messages that were sent by python since the last call to GetAndClearReceivedMessages.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a48b8107c737958a4feec339e6ea940bb">More...</a><br /></td></tr>
<tr class="separator:a48b8107c737958a4feec339e6ea940bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a363b0216a1a7077a8fd2bad700f816a0"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a363b0216a1a7077a8fd2bad700f816a0">OnMessageReceived</a> (<a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1IncomingMessage.html">IncomingMessage</a> msg)</td></tr>
<tr class="memdesc:a363b0216a1a7077a8fd2bad700f816a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is called by the communicator every time a message is received from Python by the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.Can be called multiple times per simulation step if multiple messages were sent.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html#a363b0216a1a7077a8fd2bad700f816a0">More...</a><br /></td></tr>
<tr class="separator:a363b0216a1a7077a8fd2bad700f816a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a></td></tr>
<tr class="memitem:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a2a56f2a844918fd3ef60facebf0d73b0">QueueMessageToSend</a> (<a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1OutgoingMessage.html">OutgoingMessage</a> msg)</td></tr>
<tr class="memdesc:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queues a message to be sent to Python during the next simulation step.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a2a56f2a844918fd3ef60facebf0d73b0">More...</a><br /></td></tr>
<tr class="separator:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td colspan="2" onclick="javascript:toggleInherit('properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a></td></tr>
<tr class="memitem:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memItemLeft" align="right" valign="top">Guid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a6c254da618b29e02fafe4afdfe226de2">ChannelId</a><code> [get, protected set]</code></td></tr>
<tr class="memdesc:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="mdescLeft">&#160;</td><td class="mdescRight">An int identifier for the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a6c254da618b29e02fafe4afdfe226de2">More...</a><br /></td></tr>
<tr class="separator:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Side channel for managing raw bytes of data. </p>
<p>It is up to the clients of this side channel to interpret the messages.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2805002955aa8f7c18fb6d689d94c7a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2805002955aa8f7c18fb6d689d94c7a8">&#9670;&nbsp;</a></span>RawBytesChannel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html">RawBytesChannel</a> </td>
          <td>(</td>
          <td class="paramtype">Guid&#160;</td>
          <td class="paramname"><em>channelId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html" title="Side channel for managing raw bytes of data.">RawBytesChannel</a> provides a way to exchange raw byte arrays between <a class="el" href="namespaceUnity.html">Unity</a> and Python. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">channelId</td><td>The identifier for the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html" title="Side channel for managing raw bytes of data.">RawBytesChannel</a>. Must be the same on Python and <a class="el" href="namespaceUnity.html">Unity</a>.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a641cf2de4e005eff057e46321e18ba5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a641cf2de4e005eff057e46321e18ba5d">&#9670;&nbsp;</a></span>GetAndClearReceivedMessages()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IList&lt;byte[]&gt; GetAndClearReceivedMessages </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the messages that were sent by python since the last call to GetAndClearReceivedMessages. </p>
<dl class="section return"><dt>Returns</dt><dd>a list of byte array messages that Python has sent.</dd></dl>

</div>
</div>
<a id="a48b8107c737958a4feec339e6ea940bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48b8107c737958a4feec339e6ea940bb">&#9670;&nbsp;</a></span>GetReceivedMessages()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IList&lt;byte[]&gt; GetReceivedMessages </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the messages that were sent by python since the last call to GetAndClearReceivedMessages. </p>
<p>Note that the messages received will not be cleared with a call to GetReceivedMessages.</p>
<dl class="section return"><dt>Returns</dt><dd>a list of byte array messages that Python has sent.</dd></dl>

</div>
</div>
<a id="a363b0216a1a7077a8fd2bad700f816a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a363b0216a1a7077a8fd2bad700f816a0">&#9670;&nbsp;</a></span>OnMessageReceived()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override void OnMessageReceived </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1IncomingMessage.html">IncomingMessage</a>&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Is called by the communicator every time a message is received from Python by the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.Can be called multiple times per simulation step if multiple messages were sent. </p>

<p>Implements <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a1448193c1661c98849063d89db123fc0">SideChannel</a>.</p>

</div>
</div>
<a id="a7ab4c3259a1f7e7780b883d7469c805f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ab4c3259a1f7e7780b883d7469c805f">&#9670;&nbsp;</a></span>SendRawBytes()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SendRawBytes </td>
          <td>(</td>
          <td class="paramtype">byte[]&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends the byte array message to the Python side channel. </p>
<p>The message will be sent alongside the simulation step.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>The byte array of data to send to Python.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RawBytesChannel_8cs.html">RawBytesChannel.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents_1_1SideChannels.html">SideChannels</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1RawBytesChannel.html">RawBytesChannel</a></li>
  </ul>
</div>
</body>
</html>
